/*
 * Modified MIT License
 * 
 * Copyright (c) 2006-2007 Houdah Software s.à r.l.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * Except as contained in this notice, the name(s) of the above copyright holders
 * shall not be used in advertising or otherwise to promote the sale, use or other 
 * dealings in this Software without prior written authorization.
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
**/

package com.houdah.appserver.components;

import com.houdah.appserver.support.AccessKey;

import com.webobjects.appserver.WOComponent;
import com.webobjects.appserver.WOContext;
import com.webobjects.foundation.NSMutableDictionary;

/**
 * Abstract super-class of all our components: controller, view and cell
 * 
 * 
 */
public abstract class Component extends WOComponent
{
	// Private instance variables
	
	private NSMutableDictionary	userInfo;
	
	
	
	
	// Constructor
	
	/**
	 * Designated constructor
	 * 
	 * @param contextthe
	 *            context in which this component is instantiated
	 */
	public Component(WOContext context)
	{
		super(context);
	}
	
	
	
	// Public instance methods
	
	public NSMutableDictionary userInfo()
	{
		if (this.userInfo == null) {
			this.userInfo = new NSMutableDictionary();
		}
		
		return this.userInfo;
	}
	
	
	
	// Protected instance methods
	
	/**
	 * Get a page unique access key for a given label.
	 * 
	 * @param label
	 *            the label for which an access key is needed
	 * @return an AccessKey object. May or may not hold an actual key
	 */
	protected AccessKey accessKey(String label, Object owner)
	{
		WOComponent component = context().page();
		
		if (component instanceof Page) {
			Page page = (Page) component;
			
			return page.accessKey(label, owner);
		}
		
		return AccessKey.dummyAccessKey(label);
	}
}
